Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README update, well needed #320

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

README update, well needed #320

wants to merge 9 commits into from

Conversation

AvgZing
Copy link

@AvgZing AvgZing commented Aug 13, 2017

I have maximized cleanliness in this new README update, as well as utilizing additional features that were given to us to use on Github. I also edited the wiki and updated that, so that we have a better, cleaner layout. I hope you like it, and feel free to make edits!

@AvgZing
Copy link
Author

AvgZing commented Aug 13, 2017

Side note, perhaps you should consider updating the repository description, as we are well past minecraft 0.14 😉

@AvgZing
Copy link
Author

AvgZing commented Aug 13, 2017

Final note: Delete the License patch branch! It's already merged, silly 😋

Copy link
Contributor

@dresnite dresnite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should consider keeping "Installing", "Starting/Stopping Server" and "Plugins" sections.

@AvgZing
Copy link
Author

AvgZing commented Aug 13, 2017

@GiantQuartz Perhaps, but how would I do that? Something like this?

Installation

Click here for windows installation
Click here for Mac and Linux installation

Start/Stop server

Here's a detailed guide to stopping and starting the server!

Plugins

Here's a detailed guide to using plugins!

@dishrex
Copy link
Member

dishrex commented Aug 14, 2017

I like a lot of the stuff you put in the wiki! It has been on my list to update that with general overviews, and other good information I wish someone would have told me about... However, I do not think that most of the stuff in the Readme should be substituted and linked to a wilki page. People who have source on their local machine won't have githubs wiki. I also roughly follow this as a readme guide: https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

@AvgZing
Copy link
Author

AvgZing commented Aug 14, 2017

@dishrex Sure, you brought up a good point! I'll edit the readme accordingly

@vchibikov vchibikov closed this in 6093966 Aug 14, 2017
@vchibikov vchibikov reopened this Aug 14, 2017
@ghost
Copy link

ghost commented Aug 18, 2017

Disagree

@AvgZing
Copy link
Author

AvgZing commented Aug 18, 2017

Sorry, i've been busy. I'll work on this today.

I also added extra spaces between sections
Now I'm fully done. 
NO more conflicts,
Fixed the spacing and made sections clearer
Added lbsg logo
@AvgZing
Copy link
Author

AvgZing commented Aug 18, 2017

Okay, I've finished!
I took @dishrex and @GiantQuartz's feedback into account, and modified some other stuff.
Changelog:
Wiki created
Links to wiki added in readme for easier access
Readme now has more detailed guides for more user friendliness
Increased line breaks between sections to make it easier to read
Conflicts with the base branch removed

In conclusion: This is ready to merge! Tell me what you think

@AvgZing
Copy link
Author

AvgZing commented Sep 5, 2017

Perhaps you were holding off on merging it due to the conflicts? Those are fixed now, sorry for the delay...

@AvgZing
Copy link
Author

AvgZing commented Sep 18, 2017

@dishrex @vchibikov If you get a chance, merge or give feedback! Thanks!

@AvgZing
Copy link
Author

AvgZing commented Oct 13, 2017

bump

@AvgZing
Copy link
Author

AvgZing commented Apr 5, 2018

I'm glad that there are no conflicts, after so many months.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants